ValidatedLong
A validated long number. This field is a wrapper of longs that is both a java.util.function.Supplier and java.util.function.Consumer of type Long
Author
fzzyhmstrs
Since
0.1.0
Parameters
Long. the default value of this wrapper
Long. the maximum allowed value, inclusive
Long. the minimum allowed value, inclusive
Samples
import me.fzzyhmstrs.fzzy_config.validation.number.*
fun main() {
//sampleStart
//ValidatedLong. Defaults to 1000000L, allowable range 10000000000L to 0L. Uses a Slider widget
val validatedLong = ValidatedLong(1000000L, 10000000000L, 0L)
//You can define the widget type of ValidatedLong, either a Slider or a "textbox"
val textBoxLong = ValidatedLong(1000000L, 10000000000L, 0L, ValidatedNumber.WidgetType.TEXTBOX)
//ValidatedLong built with a LongRange. can use either a Slider or a "textbox" widget.
val rangedDefaultedLong = ValidatedLong(500L, 0L..1000000L)
//ValidatedLong built with a LongRange. Uses the minimum range value for the default. can use either a Slider or a "textbox" widget.
val rangedLong = ValidatedLong(0L..1000000L)
//ValidatedLong built with just a min and max. Uses the minimum range value for the default. can use either a Slider or a "textbox" widget.
val minMaxLong = ValidatedLong(0L, 1000000L)
//unbounded ValidatedLong. Can be any valid long value. Widget forced to "textbox" style
val unboundedLong = ValidatedLong(1000000L)
//Validation-only Long (unless your default happens to be 0L)
val emptyLong = ValidatedLong()
//fields and sections have lang keys based on their "location" in the Config class graph.
//Lange key composition is as follows
//1. the namespace of the config id: (my_mod)
//2. the path of the config id: (my_mod.my_config)
//3. any parent ConfigSection field names as declared in-code: (my_mod.my_config.subSection)
//4. the setting field name as declared in-code: (my_mod.my_config.subSection.fieldName)
val fieldLang = """
{
"_comment1": "the lang for an example 'fieldName' setting in a config inside section 'subSection'",
"my_mod.my_config.subSection.fieldName": "Very Important Setting",
"my_mod.my_config.subSection.fieldName.desc": "This very important setting is used in this very important way."
}
"""
//sampleEnd
}Constructors
A validated long number generated with a LongRange.
A validated long number with a default selected from the min of the allowable range.
A validated long number with a default selected from the min of the allowable range.
an unbounded validated long number.
an unbounded validated long number with default value 0L.
Types
Functions
updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet
Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.
Copies the stored value and returns it.
The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.
translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.
Provides this validations default value
Whether this Translatable has a valid description
Whether this Translatable has a valid translation
Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue
Maps this validation to a new convertible type.
Convert this field to a ValidatedCondition using the provided validation as a supplier. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.
Convert this field to a ValidatedCondition. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.
Convert this field to a ValidatedCondition using the provided scope with a default boolean provider. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied. The provided scope must point to a valid boolean config scope otherwise the initial condition will never pass.
wraps the provided values into a ValidatedList with this field as validation
wraps the provided collection into a ValidatedList with this field as validation
wraps the provided values into a ValidatedSet with this field as validation
wraps the provided collection into a ValidatedList with this field as validation
The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated)
translation key of this Translatable. the "name" in-game
A setter method for the storedValue that first validates the value being set and then stores the post-validation result.